{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher\u003cbr\u003e\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "list_z_r_locations"
},
{
"description": "Add a location to the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account. **Prerequisites:** * Account owner or admin permissions. * Zoom Rooms Version 4.0 or higher\u003cbr\u003e\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "add_a_z_r_location"
},
{
"description": "Get the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Rooms version 4.0 or higher * Account owner or admin permissions\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "get_z_r_location_structure"
},
{
"description": "Update the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Rooms version 4.0 or higher * Account owner or admin permissions\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_zoom_rooms_location_structure"
},
{
"description": "Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to retrieve information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. **Prerequisite:**\u003cbr\u003e * Account owner or admin permission * Zoom Rooms version 4.0 or higher\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "get_z_r_location_profile"
},
{
"description": "Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. **Prerequisite:**\u003cbr\u003e * Account owner or admin permission * Zoom Rooms version 4.0 or higher\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_z_r_location_profile"
},
{
"description": "An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread accross various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. The location in the lower level in the hierarchy is considered as a child of the location that is a level above in the hierarchy. Use this API to change the parent location of a child location. \u003cbr\u003e\u003cbr\u003e For instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1, and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom Rooms are located, and you would like to rearrange the structure so that Building 1 along with its child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1, you must provide the location ID of Building 1 in the path parameter of this request and the location ID of Campus 2 as the value of `parent_location_id` in the request body.\u003cbr\u003e\u003cbr\u003e **Prerequisite:**\u003cbr\u003e * Account owner or admin permission * Zoom Rooms version 4.0 or higher\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "change_parent_location"
},
{
"description": "Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "get_z_r_location_settings"
},
{
"description": "Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. Similarly, to update **Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_z_r_location_settings"
}
]
}